👷 Deploy request for openapi-ts pending review.

Visit the deploys page to approve it

⚠️ No Changeset found

Latest commit: 1671f6f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

It opens up the possibility for using TS module augmentation to add parameters to the params property and use those in the middleware.

Wait, I can't seem to fully get this working...

declare module 'openapi-fetch' {
	interface MiddlewareRequestParams {
		timeout?: number;
	}
}

I can write a timeout middleware like this:

// Timeout middleware
fetchClient.use({
	async onRequest({ request, params: { timeout } }) {
		const signal =
			timeout === Infinity ?
				request.signal
			:	AbortSignal.any([
					request.signal,
					AbortSignal.timeout(typeof timeout === 'number' && timeout >= 0 ? timeout : REQUEST_TIMEOUT),
				]);
		return new Request(request, { signal });
	},
});

But I can't really use my custom parameter because TypeScript will yell at me if I try to do this:

client['/api/takes-a-while'].PUT({ params: { timeout: 120_000 } })

Object literal may only specify known properties, and timeout does not exist in type
{ query?: undefined; header?: undefined; path?: undefined; cookie?: undefined; }. (ts 2353)

Did you somehow get around this without telling TypeScript to ignore this line (or was this just not your use case)?

Did you somehow get around this without telling TypeScript to ignore this line (or was this just not your use case)?

Nooo, I was working on it in November and I had to circumvent it 😅 I never found a way to require the param on the calling side.

I used the client.GET(url, {timeout: 20}) syntax. There timeout was allowed but not required, should be simple enough but I don't have the time at the moment.

I used the client.GET(url, {timeout: 20}) syntax.

i was about to comment "unfortunately, custom options aren't passed along to middleware" - but it seems like they do, but apparently they're passed directly into the request :') that would work, thanks for your reply!